Skip to content

Documentation: fix the update_readme script#3186

Draft
ManonMarchand wants to merge 2 commits into
PyO3:mainfrom
ManonMarchand:document-platforms
Draft

Documentation: fix the update_readme script#3186
ManonMarchand wants to merge 2 commits into
PyO3:mainfrom
ManonMarchand:document-platforms

Conversation

@ManonMarchand
Copy link
Copy Markdown
Contributor

Hello maturin maintainers 👋

This PR does two things:

fixes the script update readme.py

The regexp was failing in two cases:

  • if the documentation had bash\nUsage: instead of Usage:
  • if the command had a dash (as in generate-ci)

Now that it works I ran it and the documentation is up to date again.

adds a precision in generate-ci doc

The deprecated argument is platform and the argument in the pyproject is platforms (plural). Took me some time to figure it out so I thought I'd add a precision in the documentation.

it is platform in the cli and platforms in the pyproject so this was a bit confusing
@messense
Copy link
Copy Markdown
Member

Thanks for the PR, tests are failing.

@ManonMarchand
Copy link
Copy Markdown
Contributor Author

Yes, I'll have time to fix the tests on monday. I'm switching to draft for now 🙂

@ManonMarchand ManonMarchand marked this pull request as draft May 14, 2026 12:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants